Skip to content

Make hint about cloning example repo more prominent #6588

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 16, 2025

Conversation

perlpunk
Copy link
Contributor

Related issue: https://progress.opensuse.org/issues/184459

I tried to create an example test in the webui, but the existing hint did not make clear to me that it would do something, I just thought it would be a link to the example distribution repo.

@perlpunk
Copy link
Contributor Author

perlpunk commented Jul 15, 2025

before:
create-example-test
after (outdated, see below):
create-example-test-new

@perlpunk
Copy link
Contributor Author

Arguably "CLICK HERE" in caps is not the nicest thing, but I didn't have an idea how to improve it otherwise.
One thing could be to color links in blue boxes something other than blue in general.

@perlpunk perlpunk force-pushed the create-example-test branch from f17b076 to f7cf51b Compare July 15, 2025 13:53
Copy link

codecov bot commented Jul 15, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.11%. Comparing base (87a4d34) to head (f016c7b).
Report is 2 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #6588   +/-   ##
=======================================
  Coverage   99.11%   99.11%           
=======================================
  Files         399      399           
  Lines       40717    40717           
=======================================
  Hits        40358    40358           
  Misses        359      359           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@Martchus
Copy link
Contributor

Martchus commented Jul 15, 2025

Arguably "CLICK HERE" in caps is not the nicest thing, but I didn't have an idea how to improve it otherwise.

I had the same though. Considering we can render an a element here we can probably also render a button with the text "Clone". So I would do that. Maybe you can actually keep using an a element and just add class="btn btn-primary".

@perlpunk perlpunk force-pushed the create-example-test branch from f7cf51b to 44bcce5 Compare July 15, 2025 16:42
@perlpunk
Copy link
Contributor Author

Arguably "CLICK HERE" in caps is not the nicest thing, but I didn't have an idea how to improve it otherwise.

I had the same though. Considering we can render an a element here we can probably also render a button with the text "Clone". So I would do that. Maybe you can actually keep using an a element and just add class="btn btn-primary".

A button, excellent!
Done that

@perlpunk
Copy link
Contributor Author

create-example-test-new-button

Copy link
Member

@okurz okurz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't quite understand the current message. Why is it necessary to click any button to clone a distribution when openQA should clone the test distribution automatically on start? Under which circumstances do we get here?

@Martchus
Copy link
Contributor

Maybe "example distribution" could now be a link to GitHub. This way users who want to know more before hitting the "Clone" button could have a look beforehand. Otherwise it is actually still quite unclear what exactly will be cloned.


@okurz I think your questions lead to far for a PR that is merely attempting to improve the UI (and not the logic behind). So I wouldn't block the merging of this PR on this discussion.

… when openQA should clone the test distribution automatically on start?

On the start of what? I don't think it is desirable that any openQA deployment automatically/unasked clones some additional repository from GitHub on first launch (if you mean that). We could trigger this automatically when one enters the specific page, though. I personally find it better if the cloning is triggered semi-automatic so users can follow better what's going on and the context of a potential error showing up is clearer.

Under which circumstances do we get here?

By clicking on "Create … Example tests" on a freshly installed openQA instance where our example distribution hasn't been cloned yet. It is required to load the scenario definitions from there.

@okurz
Copy link
Member

okurz commented Jul 16, 2025

… when openQA should clone the test distribution automatically on start?

On the start of what? I don't think it is desirable that any openQA deployment automatically/unasked clones some additional repository from GitHub on first launch (if you mean that). We could trigger this automatically when one enters the specific page, though. I personally find it better if the cloning is triggered semi-automatic so users can follow better what's going on and the context of a potential error showing up is clearer.

Under which circumstances do we get here?

By clicking on "Create … Example tests" on a freshly installed openQA instance where our example distribution hasn't been cloned yet. It is required to load the scenario definitions from there.

I see. The document is expanded. How about a button inside the scenario definitions text edit field to load the file (not the complete repo) remotely on demand? Like "Click here to fetch example scenario definitions"

@perlpunk perlpunk force-pushed the create-example-test branch from 44bcce5 to 26a6a7c Compare July 16, 2025 10:23
@perlpunk
Copy link
Contributor Author

I now changed the text to be more informative.
It's needed to automatically fill out all form fields (as you can see in my first screenshots, version, flavor and architecture are empty initially).
I don't want to spend more time on this right now, so for adding a button inside a text area I think there should be a ticket.

Related issue: https://progress.opensuse.org/issues/184459

I tried to create an example test in the webui, but the existing
hint did not make clear to me that it would do something, I just
thought it would be a link to the example distribution repo.
@perlpunk perlpunk force-pushed the create-example-test branch from 26a6a7c to f016c7b Compare July 16, 2025 10:26
@mergify mergify bot merged commit a61b311 into os-autoinst:master Jul 16, 2025
51 checks passed
@perlpunk perlpunk deleted the create-example-test branch July 16, 2025 12:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants